home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cat3
/
Xm
/
XmQTscrollFrame.z
/
XmQTscrollFrame
Wrap
Text File
|
1998-10-30
|
13KB
|
265 lines
XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
NNNNAAAAMMMMEEEE
_X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e - A widget holding this trait can handle one
or more navigator widgets
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
#include <Xm/ScrollFrameT.h>
typdefe struct {
int version;
XmScrollFrameInitProc init;
XmScrollFrameGetInfoProc getInfo;
XmScrollFrameAddNavigatorProc addNavigator;
XmScrollFrameRemoveNavigatorProc removeNavigator;
} XmSrollFrameTraitRec, *XmScrollFrameTrait;
vvvvooooiiiidddd ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeIIIInnnniiiittttPPPPrrrroooocccc))))(
WWWWiiiiddddggggeeeetttt,
XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc,
WWWWiiiiddddggggeeeetttt,
BBBBoooooooolllleeeeaaaannnn ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeGGGGeeeettttIIIInnnnffffooooPPPPrrrroooocccc))))(
WWWWiiiiddddggggeeeetttt,
CCCCaaaarrrrddddiiiinnnnaaaallll****,
WWWWiiiiddddggggeeeetttt********,
CCCCaaaarrrrddddiiiinnnnaaaallll****,
vvvvooooiiiidddd ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeAAAAddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrrPPPPrrrroooocccc))))(
WWWWiiiiddddggggeeeetttt,
WWWWiiiiddddggggeeeetttt,
MMMMaaaasssskkkk,
vvvvooooiiiidddd ((((****XXXXmmmmSSSSccccrrrroooollllllllFFFFrrrraaaammmmeeeeRRRReeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrrPPPPrrrroooocccc))))(
WWWWiiiiddddggggeeeetttt,
WWWWiiiiddddggggeeeetttt);
VVVVEEEERRRRSSSSIIIIOOOONNNN
This page documents Motif 2.1.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
A widget holding the _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e trait can handle one or
more navigator widgets and use them to pan a scrollable
object. The trait methods of _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e are useful if
you are writing you own navigator or scrollable widget.
The following standard Motif manager widgets hold this
trait:
+o XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww
+o XXXXmmmmNNNNooootttteeeebbbbooooooookkkk
In addition, the following standard Motif widgets access the
trait methods of _X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e:
+o XXXXmmmmLLLLiiiisssstttt
Page 1 (printed 10/24/98)
XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
+o XXXXmmmmTTTTeeeexxxxtttt
TTTThhhheeee iiiinnnniiiitttt TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
vvvvooooiiiidddd iiiinnnniiiitttt(
WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
XXXXttttCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc mmmmoooovvvveeeeCCCCBBBB,
WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllaaaabbbblllleeeeWWWWiiiiddddggggeeeetttt);
The iiiinnnniiiitttt trait method initializes several internal data
fields. One of these fields must hold the name the default
move callback (_m_o_v_e_C_B) procedure that is to be associated
with this widget.
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
Specifies the widget that holds the
_X_m_Q_T_s_c_r_o_l_l_F_r_a_m_e trait.
_m_o_v_e_C_B Specifies the default move callback procedure that
is to be associated with this widget. Typically,
this callback is going to be added to a list of
navigator widgets maintained by the
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t.
_s_c_r_o_l_l_a_b_l_e_W_i_d_g_e_t
Specifies client data to be passed to the _m_o_v_e_C_B.
Typically, the client data will be the name of a
scrollable widget.
TTTThhhheeee ggggeeeettttIIIInnnnffffoooo TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
BBBBoooooooolllleeeeaaaannnn ggggeeeettttIIIInnnnffffoooo(
WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
CCCCaaaarrrrddddiiiinnnnaaaallll ****ddddiiiimmmmeeeennnnssssiiiioooonnnn,
WWWWiiiiddddggggeeeetttt ********nnnnaaaavvvv____lllliiiisssstttt,
CCCCaaaarrrrddddiiiinnnnaaaallll ****nnnnuuuummmm____nnnnaaaavvvv____lllliiiisssstttt);
The ggggeeeettttIIIInnnnffffoooo trait method returns information about the
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t. The caller may set the _d_i_m_e_n_s_i_o_n,
_n_a_v__l_i_s_t, or _n_u_m__n_a_v__l_i_s_t fields to _N_U_L_L if the returned
information would be of no interest.
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
Specifies the widget that is providing this
method.
_d_i_m_e_n_s_i_o_n Returns the dimension(s) that _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_tis
capable of operating upon.
_n_a_v__l_i_s_t Returns the current list of navigators associated
with this _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t. This data is
returned to internal storage, and should not be
modified or freed by the caller.
Page 2 (printed 10/24/98)
XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
_n_u_m__n_a_v__l_i_s_t
Returns the number of navigators returned in
_n_a_v__l_i_s_t.
This method returns _T_r_u_e if the iiiinnnniiiitttt trait method was
already called. This method returns _F_a_l_s_e if iiiinnnniiiitttthas not yet
been called. If this method returns _F_a_l_s_e, then the returned
information in the other fields should be ignored.
TTTThhhheeee aaaaddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrr TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
vvvvooooiiiidddd aaaaddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrr(
WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
WWWWiiiiddddggggeeeetttt nnnnaaaavvvviiiiggggaaaattttoooorrrrWWWWiiiiddddggggeeeetttt,
MMMMaaaasssskkkk ddddiiiimmmmMMMMaaaasssskkkk);
The aaaaddddddddNNNNaaaavvvviiiiggggaaaattttoooorrrr trait method associates a
_n_a_v_i_g_a_t_o_r_W_i_d_g_e_twith a _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t. Since one
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t can support multiple navigator widgets, it
is possible that this method will be called multiple times.
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
Specifies the scroll frame widget that is
providing this method.
_n_a_v_i_g_a_t_o_r_W_i_d_g_e_t
Specifies the navigator widget to be associated
with the _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t.
_d_i_m_M_a_s_k Specifies the dimension(s) upon which the
_n_a_v_i_g_a_t_o_r_W_i_d_g_e_tis going to operate.
TTTThhhheeee rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr TTTTrrrraaaaiiiitttt MMMMeeeetttthhhhoooodddd
vvvvooooiiiidddd rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr(
WWWWiiiiddddggggeeeetttt ssssccccrrrroooollllllllFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeetttt,
WWWWiiiiddddggggeeeetttt nnnnaaaavvvviiiiggggaaaattttoooorrrrWWWWiiiiddddggggeeeetttt);
The rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr trait method disassociates a
_n_a_v_i_g_a_t_o_r_W_i_d_g_e_tfrom a _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t. Since one
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t can support multiple _n_a_v_i_g_a_t_o_r_W_i_d_g_e_ts,
this method can be called multiple times.
It is the responsibility of whomever associated the
_n_a_v_i_g_a_t_o_r_W_i_d_g_e_twith the _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t to call
rrrreeeemmmmoooovvvveeeeNNNNaaaavvvviiiiggggaaaattttoooorrrr prior to destroying it.
_s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t
Specifies the scroll frame widget that is
providing this method.
_n_a_v_i_g_a_t_o_r_W_i_d_g_e_t
Specifies the navigator widget to be disassociated
from the _s_c_r_o_l_l_F_r_a_m_e_W_i_d_g_e_t.
Page 3 (printed 10/24/98)
XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmQQQQTTTTssssccccrrrroooollllllllFFFFrrrraaaammmmeeee((((3333XXXX))))
RRRREEEELLLLAAAATTTTEEEEDDDD
XXXXmmmmSSSSccccrrrroooolllllllleeeeddddWWWWiiiinnnnddddoooowwww(3), XXXXmmmmNNNNooootttteeeebbbbooooooookkkk(3), and XXXXmmmmQQQQTTTTnnnnaaaavvvviiiiggggaaaattttoooorrrr(3).
Page 4 (printed 10/24/98)